package de.softwareforge.published.util;

/*
 * Copyright (C) 2007-2008 Henning P. Schmiedehausen
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Locale Keys for the various messages available in message.properties. Using an Enumeration ensures that the key definition is in
 * a single place and all usages can be easily found.
 *
 * @author <a href="mailto:henning@schmiedehausen.org">Henning P. Schmiedehausen</a>
 * @version $Id:PublishedStatusCalculator.java 357 2007-08-13 20:57:20Z hps@intermeta.de $
 * @api.level unpublished
 */
public enum LocaleMsg
{
    MSG_PUBLISH_UNPUBLISHED("msg.publish.unpublished"),
    MSG_PUBLISH_PUBLISHED_UNSTABLE("msg.publish.published-unstable"),
    MSG_PUBLISH_PUBLISHED_REVISION("msg.publish.published-revision"),
    MSG_PUBLISH_PUBLISHED_MINOR("msg.publish.published-minor"),
    MSG_PUBLISH_PUBLISHED_MAJOR("msg.publish.published-major"),
    MSG_PUBLISH_PUBLISHED_STABLE("msg.publish.published-stable"),

    MSG_TYPE_CONSTRUCTOR("msg.type.constructor"),
    MSG_TYPE_METHOD("msg.type.method"),
    MSG_TYPE_FIELD("msg.type.field"),
    MSG_TYPE_ANNOTATIONTYPE("msg.type.annotationType"),
    MSG_TYPE_ANNOTATIONTYPEELEMENT("msg.type.annotationTypeElement"),
    MSG_TYPE_ENUM("msg.type.enum"),
    MSG_TYPE_ENUMCONSTANT("msg.type.enumConstant"),
    MSG_TYPE_INTERFACE("msg.type.interface"),
    MSG_TYPE_CLASS("msg.type.class"),
    MSG_TYPE_PACKAGE("msg.type.package"),
    MSG_TYPE_ROOT("msg.type.root"),
    MSG_TYPE_UNKNOWN("msg.type.unknown"),

    MSG_HEADER("msg.header"),

    ERROR_NO_STATUS_INFORMATION("error.no.status.information"),
    ERROR_VISIBILITY_CHANGE("error.visibility.change"),

    NOTICE_VISIBILITY_CHANGE("notice.visibility.change"),
    NOTICE_NEED_RERUN("notice.need.rerun"),

    WARN_NO_LEVEL("warn.no.level"),
    WARN_NO_TAGEXT("warn.no.tagext"),
    WARN_TOO_MANY_TAGS("warn.too.many.tags"),
    WARN_UNKNOWN_STATE("warn.unknown.state"),
    WARN_UNKNOWN_LEVEL("warn.unknown.level");

    private final String localeKey;

    private LocaleMsg(final String localeKey)
    {
        this.localeKey = localeKey;
    }

    /**
     * @see Object#toString()
     */
    @Override
    public String toString()
    {
        return localeKey;
    }
}
